<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>OsinfoAvatarFormat: Libosinfo Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Libosinfo Reference Manual">
<link rel="up" href="ch01.html" title="Libosinfo">
<link rel="prev" href="ch01.html" title="Libosinfo">
<link rel="next" href="OsinfoDatamapList.html" title="OsinfoDatamapList">
<meta name="generator" content="GTK-Doc V1.29 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#OsinfoAvatarFormat.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#OsinfoAvatarFormat.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#OsinfoAvatarFormat.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="OsinfoDatamapList.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="OsinfoAvatarFormat"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="OsinfoAvatarFormat.top_of_page"></a>OsinfoAvatarFormat</span></h2>
<p>OsinfoAvatarFormat — The required format of avatar for an install script</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="OsinfoAvatarFormat.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="OsinfoAvatarFormat.html" title="OsinfoAvatarFormat"><span class="returnvalue">OsinfoAvatarFormat</span></a> *
</td>
<td class="function_name">
<a class="link" href="OsinfoAvatarFormat.html#osinfo-avatar-format-new" title="osinfo_avatar_format_new ()">osinfo_avatar_format_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="OsinfoAvatarFormat.html#osinfo-avatar-format-get-mime-types" title="osinfo_avatar_format_get_mime_types ()">osinfo_avatar_format_get_mime_types</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="OsinfoAvatarFormat.html#osinfo-avatar-format-get-width" title="osinfo_avatar_format_get_width ()">osinfo_avatar_format_get_width</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
</td>
<td class="function_name">
<a class="link" href="OsinfoAvatarFormat.html#osinfo-avatar-format-get-height" title="osinfo_avatar_format_get_height ()">osinfo_avatar_format_get_height</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="OsinfoAvatarFormat.html#osinfo-avatar-format-get-alpha" title="osinfo_avatar_format_get_alpha ()">osinfo_avatar_format_get_alpha</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="OsinfoAvatarFormat.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="OsinfoAvatarFormat.html#OsinfoAvatarFormat--alpha" title="The “alpha” property">alpha</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="OsinfoAvatarFormat.html#OsinfoAvatarFormat--height" title="The “height” property">height</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></td>
<td class="property_name"><a class="link" href="OsinfoAvatarFormat.html#OsinfoAvatarFormat--mime-types" title="The “mime-types” property">mime-types</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
<td class="property_name"><a class="link" href="OsinfoAvatarFormat.html#OsinfoAvatarFormat--width" title="The “width” property">width</a></td>
<td class="property_flags">Read</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="OsinfoAvatarFormat.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="OsinfoAvatarFormat.html#OSINFO-AVATAR-FORMAT-PROP-MIME-TYPE:CAPS" title="OSINFO_AVATAR_FORMAT_PROP_MIME_TYPE">OSINFO_AVATAR_FORMAT_PROP_MIME_TYPE</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="OsinfoAvatarFormat.html#OSINFO-AVATAR-FORMAT-PROP-WIDTH:CAPS" title="OSINFO_AVATAR_FORMAT_PROP_WIDTH">OSINFO_AVATAR_FORMAT_PROP_WIDTH</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="OsinfoAvatarFormat.html#OSINFO-AVATAR-FORMAT-PROP-HEIGHT:CAPS" title="OSINFO_AVATAR_FORMAT_PROP_HEIGHT">OSINFO_AVATAR_FORMAT_PROP_HEIGHT</a></td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="OsinfoAvatarFormat.html#OSINFO-AVATAR-FORMAT-PROP-ALPHA:CAPS" title="OSINFO_AVATAR_FORMAT_PROP_ALPHA">OSINFO_AVATAR_FORMAT_PROP_ALPHA</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="OsinfoAvatarFormat.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> <a class="link" href="OsinfoEntity.html" title="OsinfoEntity">OsinfoEntity</a>
        <span class="lineart">╰──</span> OsinfoAvatarFormat
</pre>
</div>
<div class="refsect1">
<a name="OsinfoAvatarFormat.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="OsinfoAvatarFormat.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="osinfo-avatar-format-new"></a><h3>osinfo_avatar_format_new ()</h3>
<pre class="programlisting"><a class="link" href="OsinfoAvatarFormat.html" title="OsinfoAvatarFormat"><span class="returnvalue">OsinfoAvatarFormat</span></a> *
osinfo_avatar_format_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Construct a new user avatar file for an <a class="link" href="OsinfoInstallScript.html" title="OsinfoInstallScript"><span class="type">OsinfoInstallScript</span></a>.</p>
<div class="refsect3">
<a name="osinfo-avatar-format-new.returns"></a><h4>Returns</h4>
<p>the necessary information to create an avatar for
an user. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="osinfo-avatar-format-get-mime-types"></a><h3>osinfo_avatar_format_get_mime_types ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
osinfo_avatar_format_get_mime_types (<em class="parameter"><code><a class="link" href="OsinfoAvatarFormat.html" title="OsinfoAvatarFormat"><span class="type">OsinfoAvatarFormat</span></a> *avatar</code></em>);</pre>
<div class="refsect3">
<a name="osinfo-avatar-format-get-mime-types.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>avatar</p></td>
<td class="parameter_description"><p>the avatar info</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="osinfo-avatar-format-get-mime-types.returns"></a><h4>Returns</h4>
<p>the required mime-types of the avatar. </p>
<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="osinfo-avatar-format-get-width"></a><h3>osinfo_avatar_format_get_width ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
osinfo_avatar_format_get_width (<em class="parameter"><code><a class="link" href="OsinfoAvatarFormat.html" title="OsinfoAvatarFormat"><span class="type">OsinfoAvatarFormat</span></a> *avatar</code></em>);</pre>
<div class="refsect3">
<a name="osinfo-avatar-format-get-width.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>avatar</p></td>
<td class="parameter_description"><p>the avatar info</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="osinfo-avatar-format-get-width.returns"></a><h4>Returns</h4>
<p> the required width (in pixels) of the avatar, or -1.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="osinfo-avatar-format-get-height"></a><h3>osinfo_avatar_format_get_height ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="returnvalue">gint</span></a>
osinfo_avatar_format_get_height (<em class="parameter"><code><a class="link" href="OsinfoAvatarFormat.html" title="OsinfoAvatarFormat"><span class="type">OsinfoAvatarFormat</span></a> *avatar</code></em>);</pre>
<div class="refsect3">
<a name="osinfo-avatar-format-get-height.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>avatar</p></td>
<td class="parameter_description"><p>the avatar info</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="osinfo-avatar-format-get-height.returns"></a><h4>Returns</h4>
<p> the required height (in pixels) of the avatar, or -1.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="osinfo-avatar-format-get-alpha"></a><h3>osinfo_avatar_format_get_alpha ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
osinfo_avatar_format_get_alpha (<em class="parameter"><code><a class="link" href="OsinfoAvatarFormat.html" title="OsinfoAvatarFormat"><span class="type">OsinfoAvatarFormat</span></a> *avatar</code></em>);</pre>
<div class="refsect3">
<a name="osinfo-avatar-format-get-alpha.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>avatar</p></td>
<td class="parameter_description"><p>the avatar info</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="osinfo-avatar-format-get-alpha.returns"></a><h4>Returns</h4>
<p> Whether alpha channel is supported in the avatar.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="OsinfoAvatarFormat.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="OSINFO-AVATAR-FORMAT-PROP-MIME-TYPE:CAPS"></a><h3>OSINFO_AVATAR_FORMAT_PROP_MIME_TYPE</h3>
<pre class="programlisting">#define OSINFO_AVATAR_FORMAT_PROP_MIME_TYPE "mime-type"
</pre>
</div>
<hr>
<div class="refsect2">
<a name="OSINFO-AVATAR-FORMAT-PROP-WIDTH:CAPS"></a><h3>OSINFO_AVATAR_FORMAT_PROP_WIDTH</h3>
<pre class="programlisting">#define OSINFO_AVATAR_FORMAT_PROP_WIDTH     "width"
</pre>
</div>
<hr>
<div class="refsect2">
<a name="OSINFO-AVATAR-FORMAT-PROP-HEIGHT:CAPS"></a><h3>OSINFO_AVATAR_FORMAT_PROP_HEIGHT</h3>
<pre class="programlisting">#define OSINFO_AVATAR_FORMAT_PROP_HEIGHT    "height"
</pre>
</div>
<hr>
<div class="refsect2">
<a name="OSINFO-AVATAR-FORMAT-PROP-ALPHA:CAPS"></a><h3>OSINFO_AVATAR_FORMAT_PROP_ALPHA</h3>
<pre class="programlisting">#define OSINFO_AVATAR_FORMAT_PROP_ALPHA     "alpha"
</pre>
</div>
</div>
<div class="refsect1">
<a name="OsinfoAvatarFormat.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="OsinfoAvatarFormat--alpha"></a><h3>The <code class="literal">“alpha”</code> property</h3>
<pre class="programlisting">  “alpha”                    <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether alpha channel is supported in the avatar.</p>
<p>Flags: Read</p>
<p>Default value: TRUE</p>
</div>
<hr>
<div class="refsect2">
<a name="OsinfoAvatarFormat--height"></a><h3>The <code class="literal">“height”</code> property</h3>
<pre class="programlisting">  “height”                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The required height (in pixels) of the avatar.</p>
<p>Flags: Read</p>
<p>Allowed values: &gt;= -1</p>
<p>Default value: -1</p>
</div>
<hr>
<div class="refsect2">
<a name="OsinfoAvatarFormat--mime-types"></a><h3>The <code class="literal">“mime-types”</code> property</h3>
<pre class="programlisting">  “mime-types”               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a></pre>
<p>The allowed mime-types for the avatar.</p>
<p>Type: GLib.List(utf8)
Transfer: container</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="OsinfoAvatarFormat--width"></a><h3>The <code class="literal">“width”</code> property</h3>
<pre class="programlisting">  “width”                    <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
<p>The required width (in pixels) of the avatar.</p>
<p>Flags: Read</p>
<p>Allowed values: &gt;= -1</p>
<p>Default value: -1</p>
</div>
</div>
<div class="refsect1">
<a name="OsinfoAvatarFormat.see-also"></a><h2>See Also</h2>
<p><a class="link" href="OsinfoInstallScript.html" title="OsinfoInstallScript"><span class="type">OsinfoInstallScript</span></a></p>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.29</div>
</body>
</html>